gridpack::ymatrix::YMBranch Class Reference

#include <ymatrix_components.hpp>

Inheritance diagram for gridpack::ymatrix::YMBranch:

Collaboration diagram for gridpack::ymatrix::YMBranch:

Public Member Functions
	YMBranch (void)
	~YMBranch (void)
bool	matrixForwardSize (int isize, int jsize) const
bool	matrixReverseSize (int isize, int jsize) const
bool	matrixForwardValues (ComplexType *values)
bool	matrixReverseValues (ComplexType *values)
void	setYBus (void)
gridpack::ComplexType	getForwardYBus (void)
gridpack::ComplexType	getReverseYBus (void)
void	load (const boost::shared_ptr< gridpack::component::DataCollection > &data)
gridpack::ComplexType	getAdmittance (void)
gridpack::ComplexType	getTransformer (YMBus *bus)
gridpack::ComplexType	getShunt (YMBus *bus)
void	getLineElements (const std::string tag, gridpack::ComplexType Yii, gridpack::ComplexType Yij)
void	getRvrsLineElements (const std::string tag, gridpack::ComplexType Yii, gridpack::ComplexType Yij)
std::vector< bool >	getLineStatus ()
std::vector< std::string >	getLineTags ()
bool	setLineStatus (std::string tag, bool status)
void	setMode (int mode)
double	getSusceptance (std::string tag)
void	setParam (std::string name, double value, int idx)
void	getYElements (std::vector< double > &yffr, std::vector< double > &yffi, std::vector< double > &yttr, std::vector< double > &ytti, std::vector< double > &yftr, std::vector< double > &yfti, std::vector< double > &ytfr, std::vector< double > &ytfi, std::vector< bool > &switched)

Constructor & Destructor Documentation

gridpack::ymatrix::YMBranch::YMBranch ( void )

Simple constructor

gridpack::ymatrix::YMBranch::~YMBranch ( void )

Simple destructor

Member Function Documentation

gridpack::ComplexType gridpack::ymatrix::YMBranch::getAdmittance ( void )

Return the complex admittance of the branch

Returns:: : complex addmittance of branch

Reimplemented in gridpack::state_estimation::SEBranch.

gridpack::ComplexType gridpack::ymatrix::YMBranch::getForwardYBus ( void )

Get values of YBus matrix. These can then be used in subsequent calculations

void gridpack::ymatrix::YMBranch::getLineElements	(	const std::string	tag,
		gridpack::ComplexType *	Yii,
		gridpack::ComplexType *	Yij
	)

Return contributions to Y-matrix from a specific transmission element

Parameters:

	tag	character string for transmission element
	Yii	contribution from "from" bus
	Yij	contribution from line element

std::vector<bool> gridpack::ymatrix::YMBranch::getLineStatus ( )

Return status of all transmission elements

Returns:: vector containing status of transmission elements

std::vector<std::string> gridpack::ymatrix::YMBranch::getLineTags ( )

Return tags of all transmission elements

Returns:: vector containging tag of transmission elements

gridpack::ComplexType gridpack::ymatrix::YMBranch::getReverseYBus ( void )

void gridpack::ymatrix::YMBranch::getRvrsLineElements	(	const std::string	tag,
		gridpack::ComplexType *	Yii,
		gridpack::ComplexType *	Yij
	)

Return contributions to Y-matrix from a specific transmission element at to end

Parameters:

	tag	character string for transmission element
	Yii	contribution from "from" bus
	Yij	contribution from line element

gridpack::ComplexType gridpack::ymatrix::YMBranch::getShunt ( YMBus * bus )

Return the contribution to a bus from shunts

Parameters:

bus,:

pointer to the bus making the call

Returns:: : contribution to Y matrix from shunts associated with branches

double gridpack::ymatrix::YMBranch::getSusceptance ( std::string tag )

Get branch susceptance (charging)

Parameters:

tag

string identifier for transmission element

Returns:: value of susceptance

gridpack::ComplexType gridpack::ymatrix::YMBranch::getTransformer ( YMBus * bus )

Return transformer contribution from the branch to the calling bus

Parameters:

bus,:

pointer to the bus making the call

Returns:: : contribution from transformers to Y matrix

void gridpack::ymatrix::YMBranch::getYElements	(	std::vector< double > &	yffr,
		std::vector< double > &	yffi,
		std::vector< double > &	yttr,
		std::vector< double > &	ytti,
		std::vector< double > &	yftr,
		std::vector< double > &	yfti,
		std::vector< double > &	ytfr,
		std::vector< double > &	ytfi,
		std::vector< bool > &	switched
	)

Return components from individual transmission elements

Parameters:

	yffr	list of real parts of Yff
	yffr	list of imaginary parts of Yff
	yttr	list of real parts of Ytt
	yttr	list of imaginary parts of Ytt
	yftr	list of real parts of Yft
	yftr	list of imaginary parts of Yft
	ytfr	list of real parts of Ytf
	ytfr	list of imaginary parts of Ytf
	switched	flag on whether line is switched or not

void gridpack::ymatrix::YMBranch::load ( const boost::shared_ptr< gridpack::component::DataCollection > & data ) [virtual]

Load values stored in DataCollection object into YMBranch object. The DataCollection object will have been filled when the network was created from an external configuration file

Parameters:

data,:

DataCollection object contain parameters relevant to this branch that were read in when network was initialized

Reimplemented from gridpack::component::BaseComponent.

Reimplemented in gridpack::powerflow::PFBranch, and gridpack::state_estimation::SEBranch.

bool gridpack::ymatrix::YMBranch::matrixForwardSize	(	int *	isize,
		int *	jsize
	)			const `[virtual]`

Return size of off-diagonal matrix block contributed by the component for the forward/reverse directions

Parameters:

isize,jsize,:

number of rows and columns of matrix block

Returns:: : false if network component does not contribute matrix element

Reimplemented from gridpack::component::MatVecInterface.

Reimplemented in gridpack::powerflow::PFBranch, and gridpack::state_estimation::SEBranch.

bool gridpack::ymatrix::YMBranch::matrixForwardValues ( ComplexType * values ) [virtual]

Return the values of the forward/reverse matrix block. The values are returned in row-major order

Parameters:

values,:

pointer to matrix block values

Returns:: : false if network component does not contribute matrix element

Reimplemented from gridpack::component::MatVecInterface.

Reimplemented in gridpack::powerflow::PFBranch, and gridpack::state_estimation::SEBranch.

bool gridpack::ymatrix::YMBranch::matrixReverseSize	(	int *	isize,
		int *	jsize
	)			const `[virtual]`

Return size of off-diagonal matrix block contributed by component. The values are for the reverse direction.

Parameters:

isize,jsize

number of rows and columns of matrix block

Returns:: false if network component does not contribute matrix element

Reimplemented from gridpack::component::MatVecInterface.

Reimplemented in gridpack::powerflow::PFBranch, and gridpack::state_estimation::SEBranch.

bool gridpack::ymatrix::YMBranch::matrixReverseValues ( ComplexType * values ) [virtual]

Return the values for an off-diagonl matrix block. The values are for the reverse direction and are returned in row-major order.

Parameters:

values

pointer to matrix block values

Returns:: false if network component does not contribute matrix element

Reimplemented from gridpack::component::MatVecInterface.

Reimplemented in gridpack::powerflow::PFBranch, and gridpack::state_estimation::SEBranch.

bool gridpack::ymatrix::YMBranch::setLineStatus	(	std::string	tag,
		bool	status
	)

Set the status of a transmission element based on its tag name

Parameters:

	tag	name of transmission element
	status	that transmission element should be set to

Returns:: false if no transmission element with that name exists

void gridpack::ymatrix::YMBranch::setMode ( int mode ) [virtual]

Set the mode to control what matrices and vectors are built when using the mapper

Parameters:

mode,:

enumerated constant for different modes

Reimplemented from gridpack::component::BaseComponent.

Reimplemented in gridpack::powerflow::PFBranch, and gridpack::state_estimation::SEBranch.

void gridpack::ymatrix::YMBranch::setParam	(	std::string	name,
		double	value,
		int	idx
	)

Set internal parameters inside the Y-branch component

Parameters:

	name	character string describing component to be modified
	value	of parameter to be modified
	idx	index (if necessary) of variable to be modified

void gridpack::ymatrix::YMBranch::setYBus ( void )

Set values of YBus matrix. These can then be used in subsequent calculations

Reimplemented in gridpack::powerflow::PFBranch, and gridpack::state_estimation::SEBranch.

The documentation for this class was generated from the following file:

ymatrix_components.hpp

gridpack::ymatrix::YMBranch Class Reference

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation